// Win32Exception.h
// (c) 2008, Charles Lechasseur
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

#ifndef RRO_UTILS_EXCEPTIONS_WIN32EXCEPTION
#define RRO_UTILS_EXCEPTIONS_WIN32EXCEPTION

#pragma once

#include "Exceptions/Exception.h"
#include <windows.h>


namespace RRO
{
    //
    // Base exception class for exceptions thrown after a failed Win32 call.
    // Includes an optional Win32 error code.
    //
    class Win32Exception : public Exception
    {
    public:
                                Win32Exception(void);
        explicit                Win32Exception(LONG p_ErrorCode);
                                Win32Exception(const Win32Exception& p_Exception);
        Win32Exception&         operator=(const Win32Exception& p_Exception);
        virtual                 ~Win32Exception(void);

        LONG                    ErrorCode(void) const;

        virtual const char*     what(void) const;   

    private:
        // The Win32 error code.
        LONG                    m_ErrorCode;
    };

}; // namespace RRO


#endif RRO_UTILS_EXCEPTIONS_WIN32EXCEPTION
